﻿//////////////////////////////////////////////////////////////////////////////
//
// Copyright © 1998-2024 Glodon Company Limited.
//
// Licensed under the MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the “Software”),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////////
#pragma once

#include "GbmpModel.h"
#include "ElementId.h"
#include "ILevel.h"

namespace gcmp 
{
    class IDocument;

    /// \brief 标高相关的工具函数类
    class GBMP_MODEL_EXPORT LevelUtils
    {
    public:
        /// \brief 获取一个单体里上一个标高使用的前缀，创建新的标高后可能会更新
        /// \param pDocument 文档指针
        /// \param buildingId 单体的Id
        /// \return 标高的前缀
        static std::wstring GetLastLevelPrefix(const IDocument *pDocument, const ElementId &buildingId);
        /// \brief 获取一个单体里上一个标高使用的后缀，创建新的标高后可能会更新
        /// \param pDocument 文档指针
        /// \param buildingId 单体的Id
        /// \return 标高的后缀
        static std::wstring GetLastLevelSuffix(const IDocument *pDocument, const ElementId &buildingId);
        /// \brief 获取一个单体里上一个标高使用的编号，创建新的标高后可能会更新
        /// \param pDocument 文档指针
        /// \param buildingId 单体的Id
        /// \return 标高的编号
        static int GetLastLevelNumber(const IDocument *pDocument, const ElementId &buildingId);
        /// \brief 获取一个单体里下一个可用的标高编号，创建新的标高后可能会更新
        /// \param pDocument 文档指针
        /// \param buildingId 单体的Id
        /// \return 标高的编号
        static int GetNextLevelNumber(const IDocument *pDocument, const ElementId &buildingId);
        /// \brief 获取一个单体里下一个可用的标高名称，创建新的标高后可能会更新
        /// \param pDocument 文档指针
        /// \param buildingId 单体的Id
        /// \return 标高的名称
        static LevelName GetNextLevelName(IDocument *pDocument, const ElementId &buildingId);

        /// \brief 根据标高的名称获取标高
        /// \param pDocument 文档指针
        /// \param levelName 标高的名称
        /// \return 标高的Id，如果不存在则返回Invalid
        static ElementId GetLevelIdByName(IDocument *pDocument, const std::wstring &levelName);

        //////////////////////////////////////////////////////////////////////////
        /// \brief 获取标高的ILevel接口
        /// \param pDocument 文档指针
        /// \param levelId 标高的Id
        /// \return ILevel接口
        static ILevel* GetLevelById(const IDocument *pDocument, const ElementId &levelId);

        /// \brief 获取文档中的所有标高的ILevel接口
        /// \param pDocument 文档指针
        /// \return 所有标高的ILevel接口
        static std::vector<const ILevel*> GetLevels(const IDocument *pDocument);

        /// \brief 获取文档的所有标高的ILevel接口，按标高值由高到低排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有标高的ILevel接口
        static std::vector<const ILevel*> GetLevelsFromHighToLow(const IDocument *pDocument);

        /// \brief 获取文档的所有标高的ILevel接口，按标高值由低到高排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有标高的ILevel接口
        static std::vector<const ILevel*> GetLevelsFromLowToHigh(const IDocument *pDocument);

        /// \brief 获取文档中的所有楼层的ILevel接口
        /// \param pDocument 文档指针
        /// \return 所有楼层的ILevel接口
        static std::vector<const ILevel*> GetStoreyLevels(const IDocument *pDocument);

        /// \brief 获取文档中的属于某一个单体的所有楼层的ILevel接口
        /// \param pDocument 文档指针
        /// \param pDocument 单体的Id
        /// \return 所有楼层的ILevel接口
        static std::vector<const ILevel*> GetStoreyLevelsInBuilding(const IDocument *pDocument, ElementId buildingId);

        /// \brief 获取文档中的所有楼层的ILevel接口，按单体Id从低到高排序，同一单体内按标高值由高到低排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有楼层的ILevel接口
        static std::vector<const ILevel*> GetStoreyLevelsFromHighToLow(const IDocument *pDocument);

        /// \brief 获取文档中的所有楼层的ILevel接口，按单体Id从低到高排序，同一单体内按标高值由低到高排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有楼层的ILevel接口
        static std::vector<const ILevel*> GetStoreyLevelsFromLowToHigh(const IDocument *pDocument);

        /// \brief 获取文档中的所有参照标高ILevel接口
        /// \param pDocument 文档指针
        /// \return 所有参照标高ILevel接口
        static std::vector<const ILevel*> GetReferenceLevels(const IDocument *pDocument);

        /// \brief 获取文档中的所有参照标高ILevel接口，按标高值由高到低排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有参照标高ILevel接口
        static std::vector<const ILevel*> GetReferenceLevelsFromHighToLow(const IDocument *pDocument);

        /// \brief 获取文档中的所有参照标高ILevel接口，按标高值由低到高排序，标高值相同则按ElementId先高后低排序
        /// \param pDocument 文档指针
        /// \return 所有参照标高ILevel接口
        static std::vector<const ILevel*> GetReferenceLevelsFromLowToHigh(const IDocument *pDocument);

        /// \brief 根据标高值，获取下一楼层（有可能为空）
        /// \param pDocument 文档指针
        /// \param elevation 当前标高值
        /// \return 下一楼层
        static const ILevel* GetLowerStoreyLevel(const IDocument *pDocument, double elevation);
        /// \brief 根据标高值，获取上一楼层（有可能为空）
        /// \param pDocument 文档指针
        /// \param elevation 当前标高值
        /// \return 上一楼层
        static const ILevel* GetHigherStoreyLevel(const IDocument *pDocument, double elevation);

        /// \brief 根据标高值，获取单体内的下一楼层（有可能为空）
        /// \param pDocument 文档指针
        /// \param elevation 当前标高值
        /// \param buildingId 单体Id
        /// \return 下一楼层
        static const ILevel* GetLowerStoreyLevel(const IDocument *pDocument, double elevation, ElementId buildingId);
        /// \brief 根据标高值，获取单体内的上一楼层（有可能为空）
        /// \param pDocument 文档指针
        /// \param elevation 当前标高值
        /// \param buildingId 单体Id
        /// \return 上一楼层
        static const ILevel* GetHigherStoreyLevel(const IDocument *pDocument, double elevation, ElementId buildingId);

        /// \brief 获取标高的高度值
        /// \param pDocument 文档指针
        /// \param levelId 标高的Id
        /// \param elevation 获取的高度值
        /// \return 是否成功获得标高的高度值
        static bool GetLevelElevation(const IDocument* pDoc, ElementId levelId, double& elevation);

        //暴力删除标高且无提示
        static bool DeleteLevelForcely(IDocument *pDocument, const ElementId& levelId, std::wstring* cannotDeleteExplanation = nullptr);
    };
}
